Skip to content

docs: Adds quickstart doc for flutter windows SDK#1231

Open
NandanPrabhu wants to merge 2 commits into
mainfrom
quickstart/flutter-windows
Open

docs: Adds quickstart doc for flutter windows SDK#1231
NandanPrabhu wants to merge 2 commits into
mainfrom
quickstart/flutter-windows

Conversation

@NandanPrabhu
Copy link
Copy Markdown
Contributor

@NandanPrabhu NandanPrabhu commented May 20, 2026

Description

This PR adds quickstart doc for auth0-flutter windows SDK. It also updates flutter quickstart to not contain details for web and windows platform but instead point to the respective flutter web and windows quickstart docs.

References

Testing

Tested it by building locally using mint dev commands

Checklist

  • I've read and followed CONTRIBUTING.md.
  • I've tested the site build for this change locally.
  • I've made appropriate docs updates for any code or config changes.
  • I've coordinated with the Product Docs and/or Docs Management team about non-trivial changes.

@NandanPrabhu NandanPrabhu requested a review from a team as a code owner May 20, 2026 07:13
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
auth0 🟢 Ready View Preview May 20, 2026, 7:18 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 20, 2026

Summary

Status Count
🔍 Total 9
✅ Successful 7
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 1
❓ Unknown 0
🚫 Errors 1
⛔ Unsupported 0

Errors per input

Errors in main/docs/quickstart/native/flutter-windows/index.mdx

… web and windows details. Instead it will point to flutter web and fluter windows for web and windows respectively
This feature is in **beta** (`auth0_flutter` 2.1.0-beta.1). The API may change before general availability.
</Note>

This guide walks you through adding login, logout, and user profile display to a Flutter Windows desktop app using the `auth0_flutter` SDK with OAuth 2.0 Authorization Code Flow + PKCE.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This guide walks you through adding login, logout, and user profile display to a Flutter Windows desktop app using the `auth0_flutter` SDK with OAuth 2.0 Authorization Code Flow + PKCE.
This guide walks you through adding login, logout, and user profile display to a Flutter Windows desktop app using the `auth0_flutter` SDK with OAuth 2.0 [Authorization Code Flow + PKCE](/docs/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce).

</Tab>

<Tab title="Dashboard">
1. Go to [Auth0 Dashboard](https://manage.auth0.com/) → **Applications > Applications**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add ending punctuation to the steps.


**Expected flow:**

1. App launches with a **Log In** button
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add ending punctuation to the steps

**Expected flow:**

1. App launches with a **Log In** button
2. Click **Log In** → your system browser opens the Auth0 Universal Login page
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Click **Log In** → your system browser opens the Auth0 Universal Login page
2. Select **Log In**. Your system browser opens the Auth0 Universal Login page.


---

## Troubleshooting & Advanced Usage
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Troubleshooting & Advanced Usage
## Troubleshoot & Advanced Use

**Symptom**: Auth0 login succeeds in browser but the app never receives the credentials.

**Fix:**
1. Open Registry Editor → `HKEY_CURRENT_USER\Software\Classes\auth0flutter\shell\open\command` and confirm the path to your `.exe`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ending punctuation

**Symptom**: Login appears to hang and eventually fails.

**Fix:** The app never received the callback URI. Verify:
1. The registry entry points to the correct executable path
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All ending punctuation

**Symptom**: A new window opens instead of the existing app receiving the callback.

**Fix:**
1. Kill all running instances in Task Manager
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ending punctuation

**Fix:**
1. Kill all running instances in Task Manager
2. Ensure the mutex name is consistent in `main.cpp`
3. Rebuild: `flutter clean && flutter run -d windows`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Rebuild: `flutter clean && flutter run -d windows`
3. Rebuild with the following command: `flutter clean && flutter run -d windows`.


**Symptom**: Error "redirect_uri_mismatch" from Auth0.

**Fix:**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ending punctuation for these steps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants